Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scm Provider
  3. API Docs
  4. Provider
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

scm.Provider

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

    The provider type for the scm package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             auth_file: Optional[str] = None,
             auth_url: Optional[str] = None,
             client_id: Optional[str] = None,
             client_secret: Optional[str] = None,
             headers: Optional[Mapping[str, str]] = None,
             host: Optional[str] = None,
             logging: Optional[str] = None,
             port: Optional[int] = None,
             protocol: Optional[str] = None,
             scope: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:scm
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    AuthFile string
    The file path to the JSON file with auth creds for SCM.
    AuthUrl string
    The URL to send auth credentials to which will return a JWT. Default: https://auth.apps.paloaltonetworks.com/auth/v1/oauth2/access_token. Environment variable: SCM_AUTH_URL. JSON config file variable: auth_url.
    ClientId string
    The client ID for the connection. Environment variable: SCM_CLIENT_ID. JSON config file variable: client_id.
    ClientSecret string
    The client secret for the connection. Environment variable: SCM_CLIENT_SECRET. JSON config file variable: client_secret.
    Headers Dictionary<string, string>
    Custom HTTP headers to be sent with all API commands. Environment variable: SCM_HEADERS. JSON config file variable: headers.
    Host string
    The hostname of Strata Cloud Manager API. Default: api.sase.paloaltonetworks.com. Environment variable: SCM_HOST. JSON config file variable: host.
    Logging string
    The logging level of the provider and the underlying communication. Default: quiet. Environment variable: SCM_LOGGING. JSON config file variable: logging.
    Port int
    The port number to use for API commands, if non-standard for the given protocol. Environment variable: SCM_PORT. JSON config file variable: port.
    Protocol string
    The protocol to use for SCM. This should be 'http' or 'https'. Default: https. Environment variable: SCM_PROTOCOL. JSON config file variable: protocol.
    Scope string
    The client scope. Environment variable: SCM_SCOPE. JSON config file variable: scope.
    AuthFile string
    The file path to the JSON file with auth creds for SCM.
    AuthUrl string
    The URL to send auth credentials to which will return a JWT. Default: https://auth.apps.paloaltonetworks.com/auth/v1/oauth2/access_token. Environment variable: SCM_AUTH_URL. JSON config file variable: auth_url.
    ClientId string
    The client ID for the connection. Environment variable: SCM_CLIENT_ID. JSON config file variable: client_id.
    ClientSecret string
    The client secret for the connection. Environment variable: SCM_CLIENT_SECRET. JSON config file variable: client_secret.
    Headers map[string]string
    Custom HTTP headers to be sent with all API commands. Environment variable: SCM_HEADERS. JSON config file variable: headers.
    Host string
    The hostname of Strata Cloud Manager API. Default: api.sase.paloaltonetworks.com. Environment variable: SCM_HOST. JSON config file variable: host.
    Logging string
    The logging level of the provider and the underlying communication. Default: quiet. Environment variable: SCM_LOGGING. JSON config file variable: logging.
    Port int
    The port number to use for API commands, if non-standard for the given protocol. Environment variable: SCM_PORT. JSON config file variable: port.
    Protocol string
    The protocol to use for SCM. This should be 'http' or 'https'. Default: https. Environment variable: SCM_PROTOCOL. JSON config file variable: protocol.
    Scope string
    The client scope. Environment variable: SCM_SCOPE. JSON config file variable: scope.
    authFile String
    The file path to the JSON file with auth creds for SCM.
    authUrl String
    The URL to send auth credentials to which will return a JWT. Default: https://auth.apps.paloaltonetworks.com/auth/v1/oauth2/access_token. Environment variable: SCM_AUTH_URL. JSON config file variable: auth_url.
    clientId String
    The client ID for the connection. Environment variable: SCM_CLIENT_ID. JSON config file variable: client_id.
    clientSecret String
    The client secret for the connection. Environment variable: SCM_CLIENT_SECRET. JSON config file variable: client_secret.
    headers Map<String,String>
    Custom HTTP headers to be sent with all API commands. Environment variable: SCM_HEADERS. JSON config file variable: headers.
    host String
    The hostname of Strata Cloud Manager API. Default: api.sase.paloaltonetworks.com. Environment variable: SCM_HOST. JSON config file variable: host.
    logging String
    The logging level of the provider and the underlying communication. Default: quiet. Environment variable: SCM_LOGGING. JSON config file variable: logging.
    port Integer
    The port number to use for API commands, if non-standard for the given protocol. Environment variable: SCM_PORT. JSON config file variable: port.
    protocol String
    The protocol to use for SCM. This should be 'http' or 'https'. Default: https. Environment variable: SCM_PROTOCOL. JSON config file variable: protocol.
    scope String
    The client scope. Environment variable: SCM_SCOPE. JSON config file variable: scope.
    authFile string
    The file path to the JSON file with auth creds for SCM.
    authUrl string
    The URL to send auth credentials to which will return a JWT. Default: https://auth.apps.paloaltonetworks.com/auth/v1/oauth2/access_token. Environment variable: SCM_AUTH_URL. JSON config file variable: auth_url.
    clientId string
    The client ID for the connection. Environment variable: SCM_CLIENT_ID. JSON config file variable: client_id.
    clientSecret string
    The client secret for the connection. Environment variable: SCM_CLIENT_SECRET. JSON config file variable: client_secret.
    headers {[key: string]: string}
    Custom HTTP headers to be sent with all API commands. Environment variable: SCM_HEADERS. JSON config file variable: headers.
    host string
    The hostname of Strata Cloud Manager API. Default: api.sase.paloaltonetworks.com. Environment variable: SCM_HOST. JSON config file variable: host.
    logging string
    The logging level of the provider and the underlying communication. Default: quiet. Environment variable: SCM_LOGGING. JSON config file variable: logging.
    port number
    The port number to use for API commands, if non-standard for the given protocol. Environment variable: SCM_PORT. JSON config file variable: port.
    protocol string
    The protocol to use for SCM. This should be 'http' or 'https'. Default: https. Environment variable: SCM_PROTOCOL. JSON config file variable: protocol.
    scope string
    The client scope. Environment variable: SCM_SCOPE. JSON config file variable: scope.
    auth_file str
    The file path to the JSON file with auth creds for SCM.
    auth_url str
    The URL to send auth credentials to which will return a JWT. Default: https://auth.apps.paloaltonetworks.com/auth/v1/oauth2/access_token. Environment variable: SCM_AUTH_URL. JSON config file variable: auth_url.
    client_id str
    The client ID for the connection. Environment variable: SCM_CLIENT_ID. JSON config file variable: client_id.
    client_secret str
    The client secret for the connection. Environment variable: SCM_CLIENT_SECRET. JSON config file variable: client_secret.
    headers Mapping[str, str]
    Custom HTTP headers to be sent with all API commands. Environment variable: SCM_HEADERS. JSON config file variable: headers.
    host str
    The hostname of Strata Cloud Manager API. Default: api.sase.paloaltonetworks.com. Environment variable: SCM_HOST. JSON config file variable: host.
    logging str
    The logging level of the provider and the underlying communication. Default: quiet. Environment variable: SCM_LOGGING. JSON config file variable: logging.
    port int
    The port number to use for API commands, if non-standard for the given protocol. Environment variable: SCM_PORT. JSON config file variable: port.
    protocol str
    The protocol to use for SCM. This should be 'http' or 'https'. Default: https. Environment variable: SCM_PROTOCOL. JSON config file variable: protocol.
    scope str
    The client scope. Environment variable: SCM_SCOPE. JSON config file variable: scope.
    authFile String
    The file path to the JSON file with auth creds for SCM.
    authUrl String
    The URL to send auth credentials to which will return a JWT. Default: https://auth.apps.paloaltonetworks.com/auth/v1/oauth2/access_token. Environment variable: SCM_AUTH_URL. JSON config file variable: auth_url.
    clientId String
    The client ID for the connection. Environment variable: SCM_CLIENT_ID. JSON config file variable: client_id.
    clientSecret String
    The client secret for the connection. Environment variable: SCM_CLIENT_SECRET. JSON config file variable: client_secret.
    headers Map<String>
    Custom HTTP headers to be sent with all API commands. Environment variable: SCM_HEADERS. JSON config file variable: headers.
    host String
    The hostname of Strata Cloud Manager API. Default: api.sase.paloaltonetworks.com. Environment variable: SCM_HOST. JSON config file variable: host.
    logging String
    The logging level of the provider and the underlying communication. Default: quiet. Environment variable: SCM_LOGGING. JSON config file variable: logging.
    port Number
    The port number to use for API commands, if non-standard for the given protocol. Environment variable: SCM_PORT. JSON config file variable: port.
    protocol String
    The protocol to use for SCM. This should be 'http' or 'https'. Default: https. Environment variable: SCM_PROTOCOL. JSON config file variable: protocol.
    scope String
    The client scope. Environment variable: SCM_SCOPE. JSON config file variable: scope.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
    pulumi/pulumi-scm